home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / gnu / emacs / emacs1857 / src_d2.zoo / ReadMe.first
Text File  |  1991-12-10  |  6KB  |  180 lines
  1. This is what I consider the first official release of Emacs 18.57
  2. for the Atari ST. It is distribution 2 because an earlier beta version (D1)
  3. was floated to uncover bugs, and because some people could not wait for 
  4. me (I am very slow). This version is improved in a number of ways so I suggest
  5. using it, and trashing copies of the earlier version. Many people have made 
  6. this port usable. (j. bammi, a. pratt, e. roeder, e. smith, f. ridderbusch,
  7. l. lasser, to name a few...) 
  8.  
  9. There are 2 archive files that are of relevance, 
  10.  
  11.     1. 1857bin-d2.zoo- The binaries for emacs, some binary utilities 
  12.                for dumping and setting the value of _initial_stack,
  13.                and all the basic emacs lisp files necessary to
  14.                create a working ST/TT version of GNU-EMACS 18.57!
  15.  
  16.     2. 1857src-d2.zoo- The source code for the above described emacs, and 
  17.                the related utilities along with a makefile, 
  18.                and a ChangeLog file that documents all changes 
  19.                to the original FSF GNU-EMACS 18.57 distribution.
  20.  
  21. Merits of this port:
  22.  
  23.     [a] Works with TOS/MiNT, MiNT pre 0.92 requires an "stty raw" 
  24.         command prior to invoking emacs
  25.  
  26.     [b] Allows Shell command to be run from within emacs with the 
  27.         output automatically put into an emacs buffer
  28.  
  29.     [c] Allows Shell escape (^Z), this spawns a new shell whether MiNT
  30.             is present or not. This was the most pleasing overall solution
  31.         to shell-escapes that I could think of in a single/multi tasking
  32.         environment. 
  33.  
  34.     [d] Allows a dumped emacs with all startup code preloaded. 
  35.  
  36.     [e] Runs on any ST or TT with a minimum of 1024k of memory. 
  37.                         --    --
  38.     [f] If one has enough free memory, (1.2 meg is a working minimum)
  39.         one can run the wonderful GNU-CALC, calculator/symbolic math
  40.         package, available from prep.ai.mit.edu
  41.     
  42.     [g] Supports UNIXMODE long filenames/links free of charge
  43.  
  44.     [h] Supports display of 8-bit characters in any buffer provided the 
  45.         local variable "ctl-arrow" is set to something other than 
  46.         "T" or "nil". (see emacs.rc)
  47.  
  48. -------------------------------------------------------------------------------
  49. Binary Installation: 
  50.  
  51. How to go about dumping an ST/TT version of EMACS 18.57!
  52.  
  53. The file 1857bin-d2.zoo contains the following directories and files.
  54.  
  55.   1. ./lisp/     - the relevant (useful to me) e-lisp files.
  56.           some of these are absolutely required for 
  57.           dumping an emacs.
  58.  
  59.      ./lisp/term/atari.el - The Atari Keyboard Mapping file
  60.                             [see also ./emacs.rc]
  61.  
  62.   2. ./etc/    - contains the emacs DOC string file and a 
  63.           sample termcap file.
  64.  
  65.   3. ./bin/    - contains [a] temacs       - undumped raw emacs
  66.                [b] dumpfix.ttp  - dumping program from (er)
  67.                    [c] dumpemac.ttp - f. riderbusch's automated
  68.                               dumper program 
  69.                [d] printstk.ttp - show current emacs stack
  70.                [e] fixstk.ttp   - set current emacs stack
  71.  
  72.   4. ./emacs.rc    - a sample ST emacs initialization file. 
  73.           this file is very important as it loads the 
  74.           ST key bindings.
  75.  
  76. DUMPING EMACS,
  77.  
  78.   0. set the environment variable UNIXMODE to the string "/.,rCLAHbd",
  79.     on my system with BASH1.10 I do the following,
  80.  
  81.     export UNIXMODE="/.,rCLAHbd"
  82.  
  83.   1. extract 1857bin-d2.zoo via "zoo x.// 1857bin-d2.zoo"
  84.  
  85.   2. set the environment variables,
  86.      EMACSLOADPAH, EMACSLIB, EMACSDOC to ./lisp, ./lisp, ./etc respectively.
  87.         on my system with BASH1.10 I do the following in my .bashrc file,
  88.         
  89.       export EMACSLOADPATH=/dev/F/bin/emacs/lisp
  90.       export EMACSLIB=/dev/F/bin/emacs/lisp
  91.       export EMACSDOC=/dev/F/emacs/etc
  92.     
  93.  
  94.   3. cd to ./bin
  95.  
  96.     Decide on how much space (stack) you want emacs to take up. This
  97.     is a system based decision. 
  98.         
  99.         [a] If you never want to run a really large emacs package 
  100.             such as gnu-calc, then a stack value of 512k is 
  101.             appropriate for your emacs. 
  102.  
  103.         [b] If you want to run a gnu-calc or some other huge 
  104.             emacs-lisp application, a value such as 2048k or 
  105.             -1L (all memory) may be good for you. 
  106.  
  107.     The catch is if you make the stack -1L and get all memory then 
  108.     it is impossible to shell out or to run shell-command in an emacs
  109.     window. (unless one uses MiNT where a stack value of -1L works 
  110.          perfectly since one may launch emacs with a "limit" command.)
  111.  
  112.     If this make no sense to you, do not worry, just skip the next 
  113.     set of instructions (about changing the stack size) and keep 
  114.     the default stack size, (512k).
  115.  
  116.   4. Change the stack size with the fixstk.ttp utility that is included.
  117.     
  118.     ./fixstk <stack size> temacs     - this reports previous and new 
  119.                         sizes.
  120.  
  121.   5. execute the "dumpemac.ttp" file, I do a :
  122.  
  123.     ./dumpemac
  124.  
  125.      watch the program build a nice dumped version of emacs.
  126.  
  127. RUNNING EMACS,
  128.  
  129.   1. You must have the variables mentioned in 2, under dumping emacs, set
  130.      correctly.
  131.     
  132.   2. create an alias for running emacs like the following, 
  133.       
  134.     alias emacs="/dev/F/bin/emacs/bin/xemacs.ttp -q -l /dev/F/.emacs"
  135.                                                      \______________/
  136.                                      |
  137.                                 this is your
  138.                                 custom init file.
  139.  
  140.     a good choice for the ".emacs" file is the included "emacs.rc" file.
  141.  
  142.   3. set the environment variable TERMCAP to point to your "termcap" file,
  143.      set the environment variable TERM to be a valid terminal entry in 
  144.     the above TERMCAP file.
  145.  
  146.   4. just saying "emacs" should work fine now! (because of the dumping process
  147.                         a reboot may be required.)
  148.  
  149. -------------------------------------------------------------------------------
  150.  
  151. To work with the source, extract using zoo v2.1 via "zoo x.// 1857src-d2.zoo"
  152. to produce the following directory tree :
  153.  
  154.     source/
  155.        lib+/
  156.        utils/
  157.  
  158. The source/ and source/utils directories have their own makefiles, the 
  159. source/lib+ directory contains some library support necessary for building a
  160. temacs. Everything should be self explanatory :), see the file ChangeLog 
  161. if you are interested in the details. By the way all changes to the 
  162. original source are marked by conditional defines, (atarist), and have 
  163. some form of descriptive comment in place.
  164.  
  165. -------------------------------------------------------------------------------
  166.  
  167.  
  168.  
  169. BUGS, COMMENTS, PRAISE, ;-)  etc....
  170.  
  171.                     scott@sparc1.stevens-tech.edu
  172.             
  173.                     scott kolodzieski
  174.  
  175. PS. I cannot give enough praise to the people mention in the beginning of this
  176. file, for without those this would never have happened.
  177.  
  178.  
  179.  
  180.